home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / spitfire / mnumkr10.zip / MNUMKR.DOC < prev    next >
Text File  |  1996-01-23  |  9KB  |  199 lines

  1.                ═══════════════ MenuMaker v1.0 ════════════════
  2.  
  3.                  A Freeware Spitfire Display Menus Generator
  4.                        (c) 1996 by Robert G. Schiele
  5.  
  6.                          May be distributed freely!
  7.  
  8.  
  9. Installation:
  10. ────────────
  11.  
  12.         MenuMaker is simple to install. Just copy the MNUMKR10.COM file
  13. into any directory you like, then create a MNUMKR.CFG file (or modify the
  14. one provided as an example, for your own use). After that, the only
  15. restriction is that you must run MenuMaker from it's own directory. There
  16. are no command line switches.
  17.  
  18.         MenuMaker's configuration file, MNUMKR.CFG, consists of only three
  19. lines, but they must all exist, and must contain ALL the information
  20. listed below:
  21.  
  22.         Line 1: Drive:\Path to DAILYLMT.DAT, and SF??????.MNU files
  23.         Line 2: Drive:\Path to your Spitfire display files
  24.         Line 3: Your BBS's name
  25.  
  26. A sample configuration file is shown below, as it is used on my own bbs:
  27.  
  28.         C:\SF\
  29.         C:\SF\DISPLAY\
  30.         The Programmer's Corner BBS
  31.  
  32. NOTE: The MNUMKR.CFG file can contain no blank lines either at it's
  33.       beginning or at it's end, and it MUST reside in the same directory
  34.       as MNUMKR10.COM!
  35.  
  36. Useage:
  37. ──────
  38.  
  39.         Simply run MNUMKR10.COM (by typing mnumkr10) from it's own
  40. directory. After MenuMaker checks your paths (as indicated in your
  41. MNUMKR.CFG file), it presents you with a menu of options. They allow you
  42. to create display menus in .CLR and .BBS formats for your Doors, Main,
  43. Message, Files, and Sysop areas. There are also two brief "screens" of
  44. help included in the program, also accessible from the main MenuMaker
  45. menu.
  46.  
  47. What It Does:
  48. ────────────
  49.  
  50.         MenuMaker will, based on your selection, automatically create
  51. Spitfire menu display files in ANSI and ASCII formats, based on the
  52. security levels contained in your DAILYLMT.DAT file plus the security
  53. information you have included in your various SF??????.MNU files. Once you
  54. have confirmed that you wish to create display menus of any given type, it
  55. asks for no further user input before creating display menu files for ALL
  56. the access levels listed in your DAILYLMT.DAT file. It creates all of
  57. these based on the formula Feature => Security, that is, for example, if
  58. you have a security access level (among others, perhaps) of 20 in your
  59. DAILYLMT.DAT file, and, for instance, a particular door is listed in your
  60. SFDOOR.MNU file with the number 20 as it's configured security access
  61. level, then that door will be included in the SFDR20.BBS/CLR files, even
  62. though you may have opted to set it as only "=" or "<=". This really only
  63. affects the creation of display files for the doors area of your BBS,
  64. because the other Spitfire SF??????.MNU files do not offer such an option.
  65. MenuMaker was written in this somewhat simplified form to save the code
  66. that would have been necessary to include to make the other possible doors
  67. security options available.
  68.  
  69.         MenuMaker expects your SF??????.MNU files to be in their original
  70. condition: that is, if you've changed the length of some "fields" in your
  71. SFMAIN.MNU, SFMSG.MNU, SFFILE.MNU, or SFSYSOP.MNU, then the screens that
  72. MenuMaker will produce will likely look like garbage. You can change the
  73. wording of any of the above-named files, for instance, in the SFMAIN.MNU
  74. file, many sysops might change the SPITFIRE NEWSLETTER option to read
  75. something like MYBBS NEWSLETTER. This is fine, so long as the overall
  76. length of that part of the file hasn't changed. The crucial area of all
  77. the .MNU files is the part that displays the key the user is to press and
  78. the command that pressing that key carries out. For example, in the
  79. SFMAIN.MNU file, the following line appears:
  80.  
  81.                 C,<C>......... Comment To Sysop,,5,J
  82.                   |--Do NOT change the length--|
  83.  
  84. The length of the space indicated above must be 30 for the SFMSG.MNU file,
  85. and 29 for each of the SFMAIN.MNU, SFFILE.MNU, and SFSYSOP.MNU files.
  86. These are, I believe, the defaults for these files as they are shipped
  87. with Spitfire, so if you have not modified them in that way, they should
  88. work fine with MenuMaker as is.
  89.  
  90. This word of caution does not apply to the SFDOOR.MNU file, in which each
  91. line is, usually, of varying length. Because of it's totally different
  92. construction, MenuMaker has been written to take all possible parameters
  93. into account.
  94.  
  95. What It Does NOT Do:
  96. ───────────────────
  97.  
  98.         A word of CAUTION is in order here: MenuMaker does NOT offer you
  99. the option of creating display menu screens of any type for only limited
  100. access levels. That is, if you tell MenuMaker to create new Main Menu
  101. display files, it will automatically create them for ALL the levels listed
  102. in your DAILYLMT.DAT file! This was done quite deliberately, as I wanted a
  103. utility that required as little user input as possible, and don't want to
  104. have to try to recall exactly what levels my DAILYLMT.DAT file is
  105. currently listing every time I update my menu display files.
  106.  
  107.         Because of the above, if you have, for instance, some menu display
  108. files that you have heavily "customized" and that you DON'T want to be
  109. replaced, you should manually copy them to another directory BEFORE you
  110. run MenuMaker, then manually copy then back to your SF display directory
  111. afterwards. If you don't, they'll be over-written!
  112.  
  113.         MenuMaker also does NOT give the user any options about menu
  114. styles and/or colors used in the ANSI versions of the display files. These
  115. are all hardcoded into the program. Sample display screens are included in
  116. this archive, so that you can decide whether you like them or not before
  117. running MenuMaker.
  118.  
  119.         One way to test MenuMaker out with your particular BBS, to make
  120. certain that it's going to work for you and that you're going to like what
  121. it does, is to put a "dummy" SF display directory into your MNUMKR.CFG
  122. file. That is, a directory that IS a valid directory on your hard drive,
  123. but not one where any of your SF display files are going to be changed
  124. when MenuMaker writes it's output. In that fashion, you can run the
  125. program, then examine the results before you decide whether you want to
  126. use it or not.
  127.  
  128. Finally:
  129. ───────
  130.  
  131.         MenuMaker was written because I wanted a utility for my own BBS
  132. that would allow me to very quickly update my display menu files when I
  133. change a menu option for a given security access level, or when I add or
  134. delete a security access level. Because it was written to fulfill a need
  135. of mine, I have released it as freeware. If you like it and it works for
  136. you, you're free to use it. If you don't or it doesn't, then don't.
  137.  
  138. Licensing:
  139. ─────────
  140.  
  141.         MenuMaker v1.0 is provided to you as freeware. That means, you
  142. don't owe anyone any money for running it. You are automatically licensed
  143. to run MenuMaker v1.0 on as many computers as you want, for as long as you
  144. want. You are NOT, however, licensed to reverse-engineer, decompile, or
  145. otherwise make any physical changes to any of the files included in the
  146. original archive. Doing so constitutes a breach of copyright. You are
  147. permitted to make MenuMaker v1.0 available for download on your BBS, or to
  148. upload it wherever you want to, so long as all the files contained in the
  149. original archive are included.
  150.  
  151. Disclaimer:
  152. ──────────
  153.  
  154.         Although MenuMaker v1.0 has been tested and every effort has been
  155. made to make certain that it is safe to operate, I make no claims about it
  156. whatsoever except that it will take up space on your hard drive.  I do NOT
  157. claim that it is suitable, applicable, or anything else, on any computer
  158. system but my own. I do believe that, setup and configured properly, it
  159. will work for you, but I will not be responsible for any damage that may
  160. result if it does not. If you use MenuMaker v1.0, you do so entirely at
  161. your own risk.
  162.  
  163. Support:
  164. ───────
  165.  
  166.         You may contact me for comments or questions on MenuMaker v1.0 (or
  167. any of my other software products) via Internet email at:
  168.  
  169.                 <schiele@inetdirect.net>
  170.  
  171. Or write me via U.S. mail at:   Robert Schiele
  172.                                 927 N. Pennsylvania St.
  173.                                 Indianapolis, IN., 46204
  174.  
  175. Finally, should you desire, you are free to call my BBS, the Programmer's
  176. Corner BBS, at (317) 639-6796, from 3PM until Midnight (E.S.T.) daily. I
  177. do use callback verification, but if you are calling long distance, you
  178. will automatically be given an access level that will enable you to
  179. download or examine my own utilities and other files available for
  180. download on my hard drive.
  181.  
  182. Credits:
  183. ───────
  184.  
  185.         Mike Woltz, author of Spitfire, and the other folks at Buffalo
  186. Creek Software, are examples to all of us in good programming practices,
  187. value for our dollars, and outstanding support. Thanks, Mike!
  188.  
  189.         MenuMaker v1.0 was written in Microsoft's QuickBASIC 4.5, then
  190. compiled and linked using Ethan Winer's excellent PDQ library. Also
  191. included were routines from Garry Spencer's (of Spencer Technology) GPS
  192. library, generously provided by him as freeware.
  193.  
  194. "Spitfire" is (c) Mike Woltz and Buffalo Creek Software
  195. "QuickBASIC 4.5" is (c) Microsoft Corporation
  196. "PDQ" is (c) Ethan Winer and Full Moon Software
  197. "GPS" is (c) Garry Spencer and Spencer Technology
  198.  
  199.